feat(sqlite): add `StatementSync.prototype.iterate` method #54213

tpoisseau · 2024-08-05T08:36:48Z

Hello,

I wanted an iterate method for StatementSync. An SQL query can return lot of rows, for memory efficiency it seems important we can fetch rows on demand, instead collect all in an array.

I'm not a C/C++ developer, so this was really challenging to create an object with a next callback with v8. I tried to obtain Iterator.prototype so the results extends Iterator. I did not found how to do it with v8.

I'm sure my code is not ready to be merged:

memory leak.
- follow similar algorithm than All
- ~~variables for next and return callback are wrapped by v8::External~~
  added to iterable_iterator JS Object, accessed from context (.This())
no unit tests
- I did not found unit tests for sqlite module, I can do some in JS, but in C++...
- Maybe they are not mandatory for experimental modules ?
solution to have an iterable iterator from iterate() is a bit hacky. in js sqlite module I decorate the method to return Iterator.from(<result from cpp iterate>).
- If someone can help me to extend Iterator from v8 it could be great, else I'll keep the decorator.
documentation

I'm hoping to get some help here to finalize this PR, so that we all get a quality iterate method.

Manual test:

// % ./node --experimental-sqlite
sqlite = require('node:sqlite');
db = new sqlite.DatabaseSync(':memory:');
stmt = db.prepare(`WITH cte(a) AS (VALUES (1), (2), (3)) SELECT * FROM cte`);
iterator = stmt.iterate();
// > Object [Iterator] {}
iterator.map(({a}) => a).map(x => x*x).toArray();
// > [ 1, 4, 9 ]

So it's properly integrated with JS iterator protocol, it's an iterable iterator, it's integrated with IteratoHelpers.

himself65

add test in tests/parallel

lib/sqlite.js

tpoisseau · 2024-08-14T09:13:46Z

Tests are added, I did not found better approach than Iterator.from, (SafeArrayIterator is not working for this case).
So I consider the PR is ready for a complete review.

Best regards,

codecov · 2024-08-14T10:29:38Z

Codecov Report

Attention: Patch coverage is 65.32258% with 43 lines in your changes missing coverage. Please review.

Project coverage is 87.99%. Comparing base (f270462) to head (3f3b946).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/node_sqlite.cc	65.32%	30 Missing and 13 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #54213      +/-   ##
==========================================
- Coverage   88.49%   87.99%   -0.51%     
==========================================
  Files         653      653              
  Lines      187728   187852     +124     
  Branches    36182    35885     -297     
==========================================
- Hits       166136   165292     -844     
- Misses      14814    15729     +915     
- Partials     6778     6831      +53

Files with missing lines	Coverage Δ
src/node_sqlite.h	`70.00% <ø> (ø)`
src/node_sqlite.cc	`81.17% <65.32%> (-2.65%)`	⬇️

... and 92 files with indirect coverage changes

---- 🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

lib/sqlite.js

src/node_sqlite.cc

Refs: nodejs#54213 (comment)

src/node_sqlite.cc

Refs: nodejs#54213 (comment)

src/node_sqlite.cc

Refs: nodejs#54213 (comment)

src/env_properties.h

Refs: nodejs#54213 (comment) Co-authored-by: Michaël Zasso <[email protected]>

src/node_sqlite.cc

Refs: nodejs#54213 (comment)

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #25

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #26

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #27

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #28

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL:

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #30

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: TODO

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: #56119

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc: * add LJHarb to collaborators (Jordan Harband) #56132 net: * (SEMVER-MINOR) add BlockList.isBlockList(value) (James M Snell) #56078 * (SEMVER-MINOR) support blockList in net.connect (theanarkh) #56075 * (SEMVER-MINOR) support blockList in net.Server (theanarkh) #56079 * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: #56119

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) nodejs#55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) nodejs#56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) nodejs#55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #31

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc: * add LJHarb to collaborators (Jordan Harband) #56132 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 net: * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) #56075 * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076 * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) #56078 * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: #56119

PR-URL: #54213 Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) nodejs#55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) nodejs#56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) nodejs#55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #32

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) nodejs#55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) nodejs#56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) nodejs#55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213 PR-URL: #33

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Aug 5, 2024

tpoisseau force-pushed the feat-sqlite-iterate branch 2 times, most recently from 16e00d0 to 762e0dc Compare August 5, 2024 08:55

RedYetiDev added the sqlite Issues and PRs related to the SQLite subsystem. label Aug 5, 2024

tpoisseau force-pushed the feat-sqlite-iterate branch from 762e0dc to a73d026 Compare August 7, 2024 18:14

himself65 requested a review from cjihrig August 9, 2024 06:40

himself65 requested changes Aug 9, 2024

View reviewed changes

lib/sqlite.js Outdated Show resolved Hide resolved

tpoisseau force-pushed the feat-sqlite-iterate branch 2 times, most recently from 406165d to 63a780e Compare August 14, 2024 07:02

tpoisseau marked this pull request as ready for review August 14, 2024 09:05

cjihrig reviewed Aug 15, 2024

View reviewed changes

lib/sqlite.js Outdated Show resolved Hide resolved

tniessen reviewed Aug 23, 2024

View reviewed changes

lib/sqlite.js Outdated Show resolved Hide resolved

cjihrig reviewed Aug 23, 2024

View reviewed changes

src/node_sqlite.cc Outdated Show resolved Hide resolved

src/node_sqlite.cc Outdated Show resolved Hide resolved

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 24, 2024

chore: switch to snake_case

fc82998

Refs: nodejs#54213 (comment)

tpoisseau force-pushed the feat-sqlite-iterate branch from fc82998 to a413954 Compare August 25, 2024 12:22

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 25, 2024

chore: switch to snake_case

a413954

Refs: nodejs#54213 (comment)

targos reviewed Aug 25, 2024

View reviewed changes

src/node_sqlite.cc Outdated Show resolved Hide resolved

jasnell reviewed Aug 25, 2024

View reviewed changes

src/node_sqlite.cc Outdated Show resolved Hide resolved

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 25, 2024

chore: use next/value/done strings from env

88b2cbc

Refs: nodejs#54213 (comment)

targos reviewed Aug 26, 2024

View reviewed changes

src/node_sqlite.cc Outdated Show resolved Hide resolved

src/node_sqlite.cc Outdated Show resolved Hide resolved

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 26, 2024

chore: add return_string to env

e2a16a4

Refs: nodejs#54213 (comment)

targos reviewed Aug 26, 2024

View reviewed changes

src/env_properties.h Outdated Show resolved Hide resolved

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 26, 2024

fix: typo

d0c8655

Refs: nodejs#54213 (comment) Co-authored-by: Michaël Zasso <[email protected]>

jasnell reviewed Aug 27, 2024

View reviewed changes

src/node_sqlite.cc Outdated Show resolved Hide resolved

jasnell reviewed Aug 27, 2024

View reviewed changes

src/node_sqlite.cc Show resolved Hide resolved

tpoisseau added a commit to tpoisseau/node that referenced this pull request Aug 28, 2024

chore: ensure keys and values have same size

41cdbd7

Refs: nodejs#54213 (comment)

github-actions bot mentioned this pull request Nov 28, 2024

2024-12-01, Version 23.4.0 (Current), @aduh95 aduh95/node#26

Closed

github-actions bot mentioned this pull request Nov 28, 2024

2024-12-01, Version 23.4.0 (Current), @aduh95 aduh95/node#27

Closed

github-actions bot mentioned this pull request Nov 28, 2024

2024-12-01, Version 23.4.0 (Current), @aduh95 aduh95/node#28

Closed

github-actions bot mentioned this pull request Nov 30, 2024

2024-12-01, Version 23.4.0 (Current), @aduh95 aduh95/node#29

Closed

github-actions bot mentioned this pull request Nov 30, 2024

2024-12-01, Version 23.4.0 (Current), @aduh95 aduh95/node#30

Closed

nodejs-github-bot mentioned this pull request Dec 3, 2024

2024-12-10, Version 23.4.0 (Current), @targos #56119

Merged

github-actions bot mentioned this pull request Dec 6, 2024

2024-12-11, Version 23.4.0 (Current), @aduh95 aduh95/node#31

Closed

aduh95 pushed a commit that referenced this pull request Dec 10, 2024

sqlite: add StatementSync.prototype.iterate method

30628eb

PR-URL: #54213 Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>

github-actions bot mentioned this pull request Dec 11, 2024

2024-12-12, Version 23.4.0 (Current) aduh95/node#32

Closed

github-actions bot mentioned this pull request Dec 11, 2024

2024-12-12, Version 23.4.0 (Current) aduh95/node#33

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sqlite): add `StatementSync.prototype.iterate` method #54213

feat(sqlite): add `StatementSync.prototype.iterate` method #54213

tpoisseau commented Aug 5, 2024 •

edited

Loading

himself65 left a comment

tpoisseau commented Aug 14, 2024

codecov bot commented Aug 14, 2024 •

edited

Loading

feat(sqlite): add StatementSync.prototype.iterate method #54213

feat(sqlite): add StatementSync.prototype.iterate method #54213

Conversation

tpoisseau commented Aug 5, 2024 • edited Loading

himself65 left a comment

Choose a reason for hiding this comment

tpoisseau commented Aug 14, 2024

codecov bot commented Aug 14, 2024 • edited Loading

Codecov Report

feat(sqlite): add `StatementSync.prototype.iterate` method #54213

feat(sqlite): add `StatementSync.prototype.iterate` method #54213

tpoisseau commented Aug 5, 2024 •

edited

Loading

codecov bot commented Aug 14, 2024 •

edited

Loading